<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class INavigation</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface INavigation</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A type representing a state of navigation. An <a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a> can specify several  <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a>s, each associated to exactly one <a href="../sde_fastsearch_result/INavigator.html">INavigator</a>. Each group  consists of a set of <a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a>s, each of which specifies one <a href="../sde_fastsearch_result/IModifier.html">IModifier</a>  and a <a href="../sde_fastsearch_navigation/ModifyMode.html">ModifyMode</a>.</p>
<p class="description"><p>The suggested usage of this interface is to use it to maintain the history of  navigation choices performed by a user. When a new query is to be submitted,  submit this <a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a> object together with the query to the search method  in <a href="../sde_fastsearch_view/ISearchView.html">ISearchView</a>.</p><p>It is suggested that the application programmer keep the base query. Accept  new choices from the user, and change the <a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a> object accordingly,  before applying it again to the base query. This will contain navigation  logic to this class.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: INavigation.html 20 2010-01-28 14:33:07Z kenn.north $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---navigation---INavigation.php.html">/src/sde/fastsearch/navigation/INavigation.php</a> (line <span class="field">43</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																						
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a></span>
										<a href="#add" title="details" class="method-name">add</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$navigator</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#clear" title="details" class="method-name">clear</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#containsGroups" title="details" class="method-name">containsGroups</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a></span>
										<a href="#getGroup" title="details" class="method-name">getGroup</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$n</span> = <span class="var-default">0</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getGroups" title="details" class="method-name">getGroups</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$navigatorName</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#instrument" title="details" class="method-name">instrument</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isEmpty" title="details" class="method-name">isEmpty</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">Iterator</span>
										<a href="#iterator" title="details" class="method-name">iterator</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName</span> = <span class="var-default">&quot;&quot;</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#remove" title="details" class="method-name">remove</a>
											(<span class="var-type"><a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a></span>&nbsp;<span class="var-name">$group</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeByName" title="details" class="method-name">removeByName</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$navigatorName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName;</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#size" title="details" class="method-name">size</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName</span> = <span class="var-default">&quot;&quot;</span>])
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodadd" id="add"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">add</span> (line <span class="line-number">49</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a new <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a> for the given <a href="../sde_fastsearch_result/INavigator.html">INavigator</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a></span>
		<span class="method-name">
			add
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$navigator</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>
				<span class="var-name">$navigator</span>			</li>
				</ul>
		
			
	</div>
<a name="methodclear" id="clear"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">clear</span> (line <span class="line-number">66</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clears contents of this navigation.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			clear
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodcontainsGroups" id="containsGroups"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">containsGroups</span> (line <span class="line-number">73</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks for <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a>s associated to the named <a href="../sde_fastsearch_result/INavigator.html">INavigator</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			containsGroups
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$navigatorName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetGroup" id="getGroup"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getGroup</span> (line <span class="line-number">82</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the nth <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a> associated to the named <a href="../sde_fastsearch_result/INavigator.html">INavigator</a>. If  no $n is given, the first <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a> will be returned.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a></span>
		<span class="method-name">
			getGroup
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$n</span> = <span class="var-default">0</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$navigatorName</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$n</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetGroups" id="getGroups"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getGroups</span> (line <span class="line-number">88</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a>s associated to the named <a href="../sde_fastsearch_result/INavigator.html">INavigator</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getGroups
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$navigatorName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$navigatorName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodinstrument" id="instrument"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">instrument</span> (line <span class="line-number">61</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Instruments the given <a href="../sde_fastsearch_query/IQuery.html">IQuery</a> with the navigation information in this  <a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a> instance.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			instrument
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sde_fastsearch_query/IQuery.html">IQuery</a></span>
				<span class="var-name">$query</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisEmpty" id="isEmpty"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isEmpty</span> (line <span class="line-number">94</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks for content in this navigation.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isEmpty
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoditerator" id="iterator"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">iterator</span> (line <span class="line-number">101</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Iterates over the <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a>s in this navigation.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Iterator</span>
		<span class="method-name">
			iterator
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName</span> = <span class="var-default">&quot;&quot;</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$navigatorName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremove" id="remove"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">remove</span> (line <span class="line-number">107</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes the given <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			remove
		</span>
					(<span class="var-type"><a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a></span>&nbsp;<span class="var-name">$group</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a></span>
				<span class="var-name">$group</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoveByName" id="removeByName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">removeByName</span> (line <span class="line-number">113</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes the <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a>s associatd to the named <a href="../sde_fastsearch_result/INavigator.html">INavigator</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeByName
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$navigatorName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName;</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$navigatorName;</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$navigatorName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsize" id="size"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">size</span> (line <span class="line-number">120</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the number of <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a>s.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			size
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$navigatorName</span> = <span class="var-default">&quot;&quot;</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$navigatorName</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:36:05 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>